Tangoe Telecom SOAP API

22.1.x
(0 reviews)

APPENDIX B

SAMPLE REQUEST / REPONSE MESSAGES

This appendix contains some samples of request and response messages for certain web method calls.

Get Service Type ID

Successful operation

Request
<SOAP-ENV:Envelope xmlns:SOAP- ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <tns:GetServiceTypeIDRequest xmlns:tns="http://www.asentinel.com/asentinelws/schemas/invord">
            <tns:serviceTypeName>Local</tns:serviceTypeName>
        </tns:GetServiceTypeIDRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Response
<SOAP-ENV:Envelope xmlns:SOAP- ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns2:GetServiceTypeIDResponse xmlns:ns2="http://www.asentinel.com/asentinelws/schemas/invord">
            <ns2:serviceTypeID>5</ns2:serviceTypeID>
            <ns2:result>
                <ns2:code>0</ns2:code>
                <ns2:message>OK</ns2:message>
            </ns2:result>
        </ns2:GetServiceTypeIDResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Notes:

  • The obtained response message denotes a successful operation;
  • Contents of ActionResult object:
    • code is zero (0);
    • message is OK.

Errored Operation

Request
<SOAP-ENV:Envelope xmlns:SOAP- ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <tns:GetServiceTypeIDRequest xmlns:tns="http://www.asentinel.com/asentinelws/schemas/invord">
            <tns:serviceTypeName>Local Service</tns:serviceTypeName>
        </tns:GetServiceTypeIDRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Response
<SOAP-ENV:Envelope xmlns:SOAP- ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns2:GetServiceTypeIDResponse xmlns:ns2="http://www.asentinel.com/asentinelws/schemas/invord">
            <ns2:serviceTypeID>0</ns2:serviceTypeID>
            <ns2:result>
                <ns2:code>-1</ns2:code>
                <ns2:message>Could not get the service type ID from the database. The provided service type (Local Service) does not exist.
                </ns2:message>
            </ns2:result>
        </ns2:GetServiceTypeIDResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Notes:

  • The obtained response message denotes an errored operation because the provided service type name does not exist;
  • Contents of ActionResult object:
    • code is negative one (-1);
    • message provides information about the error.

Reviews